<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>beyondml package &mdash; BeyondML  documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/sphinx_highlight.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="beyondml.pt package" href="beyondml.pt.html" />
    <link rel="prev" title="beyondml" href="modules.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            BeyondML
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Documentation:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">beyondml</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">beyondml package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.html">beyondml.pt package</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.html">beyondml.tflow package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-beyondml">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">BeyondML</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="modules.html">beyondml</a></li>
      <li class="breadcrumb-item active">beyondml package</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/beyondml.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="beyondml-package">
<h1>beyondml package<a class="headerlink" href="#beyondml-package" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="beyondml.pt.html">beyondml.pt package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="beyondml.pt.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="beyondml.pt.layers.html">beyondml.pt.layers package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.Conv2D">beyondml.pt.layers.Conv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.Conv3D">beyondml.pt.layers.Conv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.Dense">beyondml.pt.layers.Dense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.FilterLayer">beyondml.pt.layers.FilterLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MaskedConv2D">beyondml.pt.layers.MaskedConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MaskedConv3D">beyondml.pt.layers.MaskedConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MaskedDense">beyondml.pt.layers.MaskedDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MaskedMultiHeadAttention">beyondml.pt.layers.MaskedMultiHeadAttention module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MaskedTransformerDecoderLayer">beyondml.pt.layers.MaskedTransformerDecoderLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MaskedTransformerEncoderLayer">beyondml.pt.layers.MaskedTransformerEncoderLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiConv2D">beyondml.pt.layers.MultiConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiConv3D">beyondml.pt.layers.MultiConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiDense">beyondml.pt.layers.MultiDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiMaskedConv2D">beyondml.pt.layers.MultiMaskedConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiMaskedConv3D">beyondml.pt.layers.MultiMaskedConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiMaskedDense">beyondml.pt.layers.MultiMaskedDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiMaxPool2D">beyondml.pt.layers.MultiMaxPool2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultiMaxPool3D">beyondml.pt.layers.MultiMaxPool3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.MultitaskNormalization">beyondml.pt.layers.MultitaskNormalization module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SelectorLayer">beyondml.pt.layers.SelectorLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SparseConv2D">beyondml.pt.layers.SparseConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SparseConv3D">beyondml.pt.layers.SparseConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SparseDense">beyondml.pt.layers.SparseDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SparseMultiConv2D">beyondml.pt.layers.SparseMultiConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SparseMultiConv3D">beyondml.pt.layers.SparseMultiConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers.SparseMultiDense">beyondml.pt.layers.SparseMultiDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.layers.html#module-beyondml.pt.layers">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="beyondml.pt.utils.html">beyondml.pt.utils package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.utils.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.utils.html#module-beyondml.pt.utils.utils">beyondml.pt.utils.utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.pt.utils.html#module-beyondml.pt.utils">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="beyondml.pt.html#module-beyondml.pt">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="beyondml.tflow.html">beyondml.tflow package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="beyondml.tflow.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="beyondml.tflow.layers.html">beyondml.tflow.layers package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.FilterLayer">beyondml.tflow.layers.FilterLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MaskedConv2D">beyondml.tflow.layers.MaskedConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MaskedConv3D">beyondml.tflow.layers.MaskedConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MaskedDense">beyondml.tflow.layers.MaskedDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiConv2D">beyondml.tflow.layers.MultiConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiConv3D">beyondml.tflow.layers.MultiConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiDense">beyondml.tflow.layers.MultiDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiMaskedConv2D">beyondml.tflow.layers.MultiMaskedConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiMaskedConv3D">beyondml.tflow.layers.MultiMaskedConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiMaskedDense">beyondml.tflow.layers.MultiMaskedDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiMaxPool2D">beyondml.tflow.layers.MultiMaxPool2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultiMaxPool3D">beyondml.tflow.layers.MultiMaxPool3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.MultitaskNormalization">beyondml.tflow.layers.MultitaskNormalization module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SelectorLayer">beyondml.tflow.layers.SelectorLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SparseConv2D">beyondml.tflow.layers.SparseConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SparseConv3D">beyondml.tflow.layers.SparseConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SparseDense">beyondml.tflow.layers.SparseDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SparseMultiConv2D">beyondml.tflow.layers.SparseMultiConv2D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SparseMultiConv3D">beyondml.tflow.layers.SparseMultiConv3D module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SparseMultiDense">beyondml.tflow.layers.SparseMultiDense module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers.SumLayer">beyondml.tflow.layers.SumLayer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.layers.html#module-beyondml.tflow.layers">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="beyondml.tflow.utils.html">beyondml.tflow.utils package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.utils.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.utils.html#module-beyondml.tflow.utils.transformer">beyondml.tflow.utils.transformer module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.utils.html#module-beyondml.tflow.utils.utils">beyondml.tflow.utils.utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="beyondml.tflow.utils.html#module-beyondml.tflow.utils">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="beyondml.tflow.html#module-beyondml.tflow">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="module-beyondml">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-beyondml" title="Permalink to this heading"></a></h2>
<p>BeyondML (formerly MANN) is a Python package which enables creating sparse multitask artificial neural networks (MANNs)
compatible with [TensorFlow](<a class="reference external" href="https://tensorflow.org">https://tensorflow.org</a>) and [PyTorch](<a class="reference external" href="https://pytorch.org">https://pytorch.org</a>). This package
contains custom layers and utilities to facilitate the training and optimization of models using the
Reduction of Sub-Network Neuroplasticity (RSN2) training procedure developed by [AI Squared, Inc](<a class="reference external" href="https://squared.ai">https://squared.ai</a>).</p>
<p>### Installation</p>
<p>This package is available through [PyPi](<a class="reference external" href="https://pypi.org">https://pypi.org</a>) and can be installed via the following command:</p>
<p><code class="docutils literal notranslate"><span class="pre">`bash</span>
<span class="pre">pip</span> <span class="pre">install</span> <span class="pre">beyondml</span>
<span class="pre">`</span></code></p>
<p>### Capabilities</p>
<p>There are two major subpackages within the BeyondML package, the <cite>beyondml.tflow</cite> and the <cite>beyondml.pt</cite> packages.
The <cite>beyondml.tflow</cite> package contains functionality for building multitask models using TensorFlow, and the
<cite>beyondml.pt</cite> package contains functionality for building multitask models using PyTorch.</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="modules.html" class="btn btn-neutral float-left" title="beyondml" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="beyondml.pt.html" class="btn btn-neutral float-right" title="beyondml.pt package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2023, BeyondML Labs.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>